﻿#region License
/* Copyright (c) 2024-2025 Eduard Gushchin.
 *
 * This software is provided 'as-is', without any express or implied warranty.
 * In no event will the authors be held liable for any damages arising from
 * the use of this software.
 *
 * Permission is granted to anyone to use this software for any purpose,
 * including commercial applications, and to alter it and redistribute it
 * freely, subject to the following restrictions:
 *
 * 1. The origin of this software must not be misrepresented; you must not
 * claim that you wrote the original software. If you use this software in a
 * product, an acknowledgment in the product documentation would be
 * appreciated but is not required.
 *
 * 2. Altered source versions must be plainly marked as such, and must not be
 * misrepresented as being the original software.
 *
 * 3. This notice may not be removed or altered from any source distribution.
 */
#endregion

namespace SDL3;

public static partial class SDL
{
    /// <summary>
    /// The flags on an <see cref="Surface"/>.
    /// </summary>
    /// <remarks>These are generally considered read-only.</remarks>
    /// <since>This datatype is available since SDL 3.2.0</since>
    [Flags]
    public enum SurfaceFlags : uint
    {
        /// <summary>
        /// Surface uses preallocated pixel memory
        /// </summary>
        Preallocated = 0x00000001u,

        /// <summary>
        /// Surface needs to be locked to access pixels
        /// </summary>
        LockNeeded = 0x00000002u,

        /// <summary>
        /// Surface is currently locked
        /// </summary>
        Locked = 0x00000004u,

        /// <summary>
        /// Surface uses pixel memory allocated with SDL_aligned_alloc()
        /// </summary>
        SimdAligned = 0x00000008u,
    }
}